<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Whm_Functions_Administration</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Whm_Functions_Administration</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WHM API Administration Functions</p>
<p class="description"><p>Calls to Administration functions of the WHM XML and JSON APIs</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Peter Kumaschow  (pkumaschowATgmail.com)</li>
				<li><span class="field">copyright:</span> Peter Kumaschow 2011</li>
				<li><span class="field">link:</span> <a href="http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi">http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi</a></li>
				<li><span class="field">license:</span> GNU</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Functions---Administration.php.html">/Functions/Administration.php</a> (line <span class="field">34</span>)
		</p>
		
				
		<pre><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a>
   |
   --Whm_Functions_Administration</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												
												<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#addip" title="details" class="method-name">addip</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$netmask</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#delip" title="details" class="method-name">delip</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$ethernetdev</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$skipifshutdown</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#listips" title="details" class="method-name">listips</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#nvget" title="details" class="method-name">nvget</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#nvset" title="details" class="method-name">nvset</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#reboot" title="details" class="method-name">reboot</a>
											([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#sethostname" title="details" class="method-name">sethostname</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setresolvers" title="details" class="method-name">setresolvers</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver1</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$nameserver2</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver3</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#showbw" title="details" class="method-name">showbw</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span> = <span class="var-default">null</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_apiresponse">Whm_Functions_Abstract::$_apiresponse</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_method">Whm_Functions_Abstract::$_method</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_params">Whm_Functions_Abstract::$_params</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_querystring">Whm_Functions_Abstract::$_querystring</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_rest">Whm_Functions_Abstract::$_rest</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodaddip" id="addip"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addip</span> (line <span class="line-number">47</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add new IP address(es) to WebHost Manager.</p>
<p class="description"><p>Note:  When adding multiple IP addresses, you must use Class C CIDR format.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			addip
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$netmask</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$netmask</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddelip" id="delip"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">delip</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete IP address.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			delip
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$ethernetdev</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$skipifshutdown</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ethernetdev</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$skipifshutdown</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistips" id="listips"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listips</span> (line <span class="line-number">87</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function lists all IP addresses bound to network  interfaces on the server.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			listips
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodnvget" id="nvget"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">nvget</span> (line <span class="line-number">103</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">cPanel and WHM store &quot;non-volatile&quot; data on your server.</p>
<p class="description"><p>You can use the nvget function to view the value of a  non-volatile variable.</p><p>Use the nvset function to set the value.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			nvget
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$key</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnvset" id="nvset"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">nvset</span> (line <span class="line-number">122</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the value of &quot;non-volatile&quot; data on  your server.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			nvset
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			
	</div>
<a name="methodreboot" id="reboot"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">reboot</span> (line <span class="line-number">139</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function can restart a server gracefully or forcefully.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			reboot
		</span>
					([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$force</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsethostname" id="sethostname"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">sethostname</span> (line <span class="line-number">158</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function lets you change the server's hostname.</p>
<p class="description"><p>Important:  The server's hostname should absolutely not be identical to your  domain name. For example, if your domain is example.com, you  could use a hostname such as server1.example.com, but not   example.com itself.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			sethostname
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$hostname</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetresolvers" id="setresolvers"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setresolvers</span> (line <span class="line-number">164</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setresolvers
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver1</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$nameserver2</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver3</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$nameserver1</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$nameserver2</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$nameserver3</span>			</li>
				</ul>
		
			
	</div>
<a name="methodshowbw" id="showbw"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">showbw</span> (line <span class="line-number">181</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function will display bandwidth information by account.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			showbw
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$optionalParams</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#method__construct">Whm_Functions_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodapplist">Whm_Functions_Abstract::applist()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodcheckParams">Whm_Functions_Abstract::checkParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methoddecode">Whm_Functions_Abstract::decode()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetApi">Whm_Functions_Abstract::getApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetMethod">Whm_Functions_Abstract::getMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetParams">Whm_Functions_Abstract::getParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetQueryString">Whm_Functions_Abstract::getQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodpost">Whm_Functions_Abstract::post()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodquickpost">Whm_Functions_Abstract::quickpost()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetApi">Whm_Functions_Abstract::setApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetMethod">Whm_Functions_Abstract::setMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetParams">Whm_Functions_Abstract::setParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetQueryString">Whm_Functions_Abstract::setQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodvalidateParams">Whm_Functions_Abstract::validateParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodversion">Whm_Functions_Abstract::version()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 06 Nov 2011 23:33:12 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>